partner10.getKeyInfo
Purpose
Retrieves Key information by Key number.
Signature
Method name: partner10.getKeyInfo
Parameters
| # | Type | Description |
|---|---|---|
| 1 | struct AuthInfo | client authentication information |
| 2 | String | key number in formats (PLSK.12345678.0001 or PLSK.12345678) or product/key activation code |
Returns struct
| Field | Type | Description |
|---|---|---|
| resultCode | int | code for command execution result (see below) |
| resultDesc | string | textual description of command execution result (see below) |
| keyInfo | struct KeyDetails | detailed info for key |
Result Codes
| resultCode | resultDesc |
|---|---|
| 100 | Key info for <key number> key returned successfully |
| 200 | Client authorization failed |
| 201 | Access to this method is denied |
| 202 | Access to this object is denied |
| 220 | Key <key number> is not found |
| 300 | Internal error, please try after some time |
| 400 | Incorrect authorization info format |
| 410 | Incorrect key number format: “<key number>” |
XML Examples
Request message
<?xml version="1.0" encoding="utf-8"?>
<methodCall>
<methodName>partner10.getKeyInfo</methodName>
<params>
<param>
<value>
<struct>
<member>
<name>login</name>
<value>
<string>API_LOGIN</string>
</value>
</member>
<member>
<name>password</name>
<value>
<string>API_PASSWORD</string>
</value>
</member>
</struct>
</value>
</param>
<param>
<value>
<string>PLSK.00123456.0000</string>
</value>
</param>
</params>
</methodCall>
Response message
<?xmlversion="1.0"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>resultCode</name>
<value>
<int>100</int>
</value>
</member>
<member>
<name>resultDesc</name>
<value>Key info for PLSK.00123456.0000 key returned successfully</value>
</member>
<member>
<name>keyNumber</name>
<value>PLSK.00123456.0000</value>
</member>
<member>
<name>keyInfo</name>
<value>
<struct>
<member>
<name>keyType</name>
<value>Plesk Control Panel 8.x (Purchased)</value>
</member>
<member>
<name>productConfigurationId</name>
<value>90691</value>
</member>
<member>
<name>expirationDate</name>
<value>
<dateTime.iso8601>20080316T00:00:00</dateTime.iso8601>
</value>
</member>
<member>
<name>susAndSupportInfo</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>expiration</name>
<value>
<dateTime.iso8601>20080905T00:00:00</dateTime.iso8601>
</value>
</member>
<member>
<name>name</name>
<value>SUSPresent</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>terminated</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>problem</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>createDate</name>
<value>
<dateTime.iso8601>20070906T09:39:22</dateTime.iso8601>
</value>
</member>
<member>
<name>clientId</name>
<value>
<int>CLIENT_ID</int>
</value>
</member>
<member>
<name>properties</name>
<value>
<struct>
<member>
<name>MLS</name>
<value>0</value>
</member>
</struct>
</value>
</member>
<member>
<name>keyNumber</name>
<value>PLSK.00123456.0001</value>
</member>
<member>
<name>boundIPAddress</name>
<value>192.168.0.1</value>
</member>
<member>
<name>billingType</name>
<value>PURCHASE</value>
</member>
<member>
<name>additionalKeys</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>keyType</name>
<value>SiteBuilder 3.0 for Unix/Linux (Purchased)</value>
</member>
<member>
<name>expirationDate</name>
<value>
<dateTime.iso8601>20080421T00:00:00</dateTime.iso8601>
</value>
</member>
<member>
<name>susAndSupportInfo</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>expiration</name>
<value>
<dateTime.iso8601>20090312T00:00:00</dateTime.iso8601>
</value>
</member>
<member>
<name>name</name>
<value>SUS Present</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>terminated</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>problem</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>createDate</name>
<value>
<dateTime.iso8601>20080312T15:16:10</dateTime.iso8601>
</value>
</member>
<member>
<name>clientId</name>
<value>
<int>CLIENT_ID</int>
</value>
</member>
<member>
<name>properties</name>
<value>
<struct></struct>
</value>
</member>
<member>
<name>keyNumber</name>
<value>SB.00012345.0000</value>
</member>
<member>
<name>boundIPAddress</name>
<value></value>
</member>
<member>
<name>billingType</name>
<value>PURCHASE</value>
</member>
<member>
<name>additionalKeys</name>
<value>
<array>
<data></data>
</array>
</value>
</member>
<member>
<name>productFamily</name>
<value>sb</value>
</member>
<member>
<name>apiKeyType</name>
<value>SITEBUILDER_30</value>
</member>
<member>
<name>features</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>apiName</name>
<value>N/A</value>
</member>
<member>
<name>name</name>
<value>100 Sites w/1yr SUS (Purchased)</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>type</name>
<value>ADDITIONAL</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>productFamily</name>
<value>plesk</value>
</member>
<member>
<name>apiKeyType</name>
<value>PLESK_8</value>
</member>
<member>
<name>features</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>apiName</name>
<value>10_DOMAINS</value>
</member>
<member>
<name>name</name>
<value>10 Domains w/1yr SUS (Purchased)</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>type</name>
<value>MAIN</value>
</member>
</struct>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>